Live Agent Chat

This is a list of classes related to Live Agent Chat. The entry point into this feature is through the SCSChat class. Refer to that class to get started.

  • The SCSChat class is the main interface to the Live Agent Chat SDK. This object manages the flow of Chat sessions throughout the lifetime of the app.

    To get an instance of this class, use the SCServiceCloud.chat property on +[SCServiceCloud sharedInstance].

    SCSChat conforms to a multicast delegate model for messaging. Any class which implements the SCSChatDelegate protocol can be added to a list of delegates to receive messages asynchronously.

    For UI-related chat features, see SCSChatInterface.

    See

    SCSChatInterface
    See more

    Declaration

    Objective-C

    @interface SCSChat : NSObject

    Swift

    class SCSChat : NSObject

  • SCSChatAvailabilityHandler block definition

    Declaration

    Objective-C

    typedef void (^SCSChatAvailabilityHandler)(NSError *__strong, BOOL)

    Swift

    typealias SCSChatAvailabilityHandler = (Error?, Bool) -> Void

    Parameters

    error

    NSError instance describing the error. Error codes can be referenced from SCSChatErrorCode.
    available

    BOOL representing the availability of an agent to accept a chat session.

  • SCSChatCompletionHandler block definition

    Declaration

    Objective-C

    typedef void (^SCSChatCompletionHandler)(NSError *__strong, SCSChat *__weak)

    Swift

    typealias SCSChatCompletionHandler = (Error?, SCSChat?) -> Void

    Parameters

    error

    NSError instance describing the error. Error codes can be referenced from SCSChatErrorCode.
    scsc

    The instance of SCSChat the block is acting on.

  • The SCSChatInterface class gives you access to the UI-related features of chat, such as chat notifications.

    See

    SCSChat
    See more

    Declaration

    Objective-C

    @interface SCSChatInterface : NSObject

    Swift

    class SCSChatInterface : NSObject

  • A SCSChatConfiguration object contains configuration information for a Live Agent Chat session.

    See more

    Declaration

    Objective-C

    @interface SCSChatConfiguration : NSObject <NSCopying>

    Swift

    class SCSChatConfiguration : NSObject, NSCopying

  • Describes how a chat session is presented.

    See more

    Declaration

    Objective-C

    enum SCSChatPresentationStyle {}

  • The SCSChatDelegate protocol provides information about the Live Agent Chat session.

    See

    SCSChat
    See more

    Declaration

    Objective-C

    @protocol SCSChatDelegate <NSObject>

    Swift

    protocol SCSChatDelegate : NSObjectProtocol

  • A SCSPrechatEntity specifies a salesforce entity related to this chat session that will be found or created on session start.

    This object must be added to your chat configuration using SCSChatConfiguration.prechatEntities.

    See more

    Declaration

    Objective-C

    @interface SCSPrechatEntity : NSObject

    Swift

    class SCSPrechatEntity : NSObject

  • A SCSPrechatEntityField specifies a field of a salesforce object and its relation to a specific pre-chat object defined on session creation.

    This object must be added to a pre-chat entity using SCSPrechatEntity.entityFieldsMaps.

    See more

    Declaration

    Objective-C

    @interface SCSPrechatEntityField : NSObject

    Swift

    class SCSPrechatEntityField : NSObject

  • A SCSPrechatObject specifies a pre-chat field that you can send directly to the agent. This object contains a label and a value.

    This object does not prompt the user for information. To create a field that the user can fill in, refer to SCSPrechatTextInputObject.

    This object must be added to your chat configuration using SCSChatConfiguration.prechatFields.

    See more

    Declaration

    Objective-C

    @interface SCSPrechatObject : NSObject <NSCopying>

    Swift

    class SCSPrechatObject : NSObject, NSCopying

  • An SCSPrechatPickerOption specifies an option inside a pre-chat picker field that is displayed before a chat session is initiated.

    This object must be added to the options array on an SCSPrechatPickerObject.

    See more

    Declaration

    Objective-C

    @interface SCSPrechatPickerOption : NSObject

    Swift

    class SCSPrechatPickerOption : NSObject